home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 026-050 / scopedisk46 / med24 / med.doc < prev    next >
Text File  |  1995-03-18  |  7KB  |  256 lines
  1.  
  2.  
  3.       DOCUMEMENTATION FOR THE VERSION 2.1 OF TEXT EDITOR MED
  4.       ======================================================
  5.  
  6.  
  7. Med is a text editor that I write specially for the Amiga. I wanted to use
  8. the features of the Amiga with a view to make a programm user-friendly
  9. So my program works with the mouse and the menus. You can edit 36 texts
  10. simultaneously. In this documentation I will try to explain some of the
  11. more specials features of Med.
  12.  
  13. I ask you to be indulgent with my english which is very poor.
  14.  
  15.  
  16. Use of the Mouse:
  17. =================
  18.  
  19.    Move the cursor.
  20.    Move the lift.
  21.    Select text:
  22.       You push down the left button of the mouse and you move it. The
  23.       select text is highlighted.
  24.       You can use an 'extended-select' mode
  25.          1. Push down the left mouse button.
  26.          2. Press the Escape key.
  27.          3. Stop push down the left mouse button.
  28.          4. Use the lift (some more times that you need).
  29.          5. Click in the window. The visible select text is highlighted.
  30.          5. You can return in 2.
  31.  
  32.       The mouse is also use for all the usual Amiga interface.
  33.  
  34.  
  35.  
  36. The menus:
  37. ==========
  38.  
  39.    They are 28. ONLY THE MENUS WHICH DON'T HAVE AN IMMEDIATE MEANING ARE
  40.    DESCRIBED.
  41.  
  42. Menu File/Quit:
  43.    Med asks you if you are really sure that you don't want save the file
  44.    you have modified. It gives you the names of this files.
  45.  
  46. Menu Edition/Special/Path:
  47.    You can give a string which will be put in front of all the filename
  48.    It 's very useful if you want use a directory which is not the current
  49.    directory and you don't always give the path to acceed to this directory.
  50.  
  51. Menu Edition/Special/Execute:
  52.    You can execute a CLI command as like from the CLI. Med is stopped since
  53.    this command runs.
  54.  
  55. Menu Edition/Special/NewCli:
  56.    You can create a new CLI.
  57.  
  58. Menu Edition/Special/Script:
  59.    You can use it for loading with an unique command several files.
  60.    When you select a request appear and ask you a filename.
  61.    This file will be use as a decript file.
  62.    All the lines of this file will be seen by Med as a description of a file
  63.    to load.
  64.       The syntax you must use is:
  65.                filename size comment
  66.          filename the file med must load. If there a path it is used.
  67.          size the buffer size that Med must used.   (optionnal)
  68.          comment for the user can be empty.
  69.  
  70.          Between the fields you must put one or more than one space.
  71.          The lines which begin by an * are comment.
  72.  
  73.             example of a script file
  74. C-DEVEL:one.window.c   20
  75. C-DEVEL:essai.c        10000
  76. * this a comment
  77. C-DEVEL:toto.c         1
  78. tob.asm                20000
  79.  
  80.          You can use this option directly from the command line with the
  81.          syntax :
  82.             Med -sfile
  83.                file must be a script file.
  84.  
  85. Menu Edition/Special/Save Table
  86. Menu Edition/Special/Load Table
  87.  
  88.     This 2 menus deal with the conversion table that Med use when it loads
  89.     file. All the character it reads are changed using this table.
  90.     Generaly the character are changed in themself.
  91.     The default table is the identity.
  92.     The menu Load Table can be use to change it. If you select it a
  93.     requester appear asking you a filename. In this file you must put lines
  94.     of this type:
  95.          iv fv comment
  96.             iv      initial value of the character in hexadecimal
  97.             fv      final value of the character in hexadecimal
  98.             comment field reserved to the user.
  99.  
  100.     These fields must be separed by one (or more) space.
  101.     If one value vi appear several times the last value is used.
  102.     If any value doesn't appear it keeps the value it has before.
  103.     The lines which begin by an * are comment.
  104.  
  105.     The menu 'Save Table' can be use to create a file which is the map
  106.     of the conversion table uses and it has the same format.
  107.  
  108.     This option is designed to be use for the work on file coming from
  109.     an another machine.
  110.  
  111. Example of a table file:
  112.  
  113. 0 20    0 are changed in space.
  114. D A     ^M becames ^J
  115. * comment
  116. 41 42   A --> B (!!!).
  117.  
  118.  
  119. Edition/Special/Without Spaces:
  120.    It defines a parameter for the write of the file on the disk
  121.    When the name of menu is 'Without Space' all the spaces which lies at
  122.    the end of the lines are not written.
  123.    When the name is 'With Space' they are.
  124.    The default mode is 'Without Space'
  125.  
  126. Window/Open
  127.    Open a new window.
  128.    It 's possible only if there are more text loaded that there are window
  129.    opened.
  130.  
  131. Window/Close
  132.    Close the active window.
  133.    It doesn't work if it is the only open window.
  134.  
  135. Window/Info
  136.    Give the number of open window.
  137.  
  138.  
  139. Text/....
  140.  
  141.    It presents all the files which are edited.
  142.    You can use 36 texts simultaneously.
  143.    The name of the file which are changed appear in a box when you put the
  144.    mouse on them the others are highlighted.
  145.  
  146.  
  147.  
  148. The soft keys.
  149. =============
  150.  
  151. F1
  152.    The cursor go to the end of the line. If it is in this position it goes
  153.    to beginning of the line.
  154.  
  155. F2
  156.    Create a new line under this of the cursor.
  157.  
  158. F3
  159.    It 's a parenthesis and accolade verificator. You put the cursor on a
  160.    parenthesis or on an accolade and the cursor goes to the matching element
  161.    if it exists. In the other case, the screen make a 'beep'.
  162.  
  163. F4
  164. F5
  165.    Move the text by a screen unit.
  166.  
  167.  
  168. F6
  169.    Repeat command which are among the menus. This command are Find,Replace,
  170.    Go to Line,Copy in a File.
  171.  
  172. F7
  173.    Give back the last part of the text which was deleted by a cut or by F10
  174.  
  175. F8
  176.    Switch upper-case and lower-case letters.
  177.  
  178. F9
  179.    Put the cursor on the next tabulation.
  180.  
  181. F10
  182.    Delete the line under the cursor.
  183.  
  184.  
  185. The control keys:
  186. ================
  187.  
  188.    They are the same that a part of the soft keys:
  189.  
  190.          ^a  == F2
  191.          ^b  == F10
  192.          ^f  == F8
  193.  
  194. Move in the text:
  195. =================
  196.  
  197.    You can use the arrow keys.
  198.    Tab pushs the cursor and the text after it.
  199.    Shift Tab does the same thing without pushing the text at the end of
  200.    the line.
  201.  
  202. Some Specifities:
  203. =================
  204.  
  205.    When you select text with the mouse, your next action specify the use
  206.    of this text.
  207.    If Med can't have the memory that it needs, it shows a requester or it
  208.    does a screen beep.
  209.  
  210.    There are no limitation on the length of the lines so you always can put
  211.    some character on the lines but they are insered at the place of the
  212.    cursor.
  213.  
  214.    Med never accepts not visible chararcter.
  215.  
  216.    The end of line is LineFeed (it is usual for the Amiga).
  217.  
  218.    The tabulation characters are always changed in spaces.
  219.  
  220.    When you load or you save a file Med doesn't do any back-up. It save
  221.    place on the disks and the user generally makes their own back-up on
  222.    another disk.
  223.  
  224.  
  225.  
  226. The command line:
  227. =================
  228.  
  229.    med [file [size]]
  230.       file file which must be load by med.
  231.       size buffer size that you instruct med to create for it.
  232.             You can give it in bytes or in kilo-bytes.
  233.  
  234.    med -sfile
  235.       You use it to load several file with only one command (see the ex-
  236.       planation above).
  237.  
  238.  
  239.  
  240. I give my thanks to Francois Rouaix who helps me to write this text in
  241. english and to test the editor and to Gerald Hewes who always push me to
  242. define more useful command.
  243.  
  244.                                  Paris the 01/27/87
  245.                                           Regis Vaillant.
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.